オプション解析モジュール docopt を使ってみよう

docopt は docscritings に記述した内容をパースしてオプション解析処理を生成してくれる、逆転の発想でオプション処理を定義する拡張モジュールです。

docoptは拡張モジュールなのでインストールする必要があります。

conda コマンドは 実行環境によっては pip コマンドを使う場合もあります。

code: bash

conda install docopt

# pipの場合

pip install docopt

argparser で使用した例を docopt で書いてみましょう。

code: 0503_docopt.py

from docopt import docopt

__VERSION__='1.0'

__doc__="""Search some files

Arguments:

FILE target file

Options:

-h, --help show this help message and exit

--version show version

-v, --verbose verbose mode

-o OUTFILE, --outfile=OUTFILE output file

--overwrite overwrite if file existing

""".format(prog=__file__)

args = docopt(__doc__,version=__VERSION__)

print(args)

まず、ヘルプメッセージを表示させてみます。

code: bash

% python 0503_docopt.py --help

Search some files

Arguments:

FILE target file

Options:

-h, --help show this help message and exit

--version show version

-v, --verbose verbose mode

-o OUTFILE, --outfile=OUTFILE output file

-p PATTER, --pat=PATTERN search pattern

--overwrite overwrite if file existing

__doc__ で定義したメッセージが出力されています。

code: bash

$ python 0503_docopt.py -p apple -o OUT --overwrite sample.csv dummy.txt

{'--help': False,

'--outfile': 'OUT',

'--overwrite': True,

'--pat': 'apple',

'--verbose': False,

'--version': False,